package com.apobates.jforum2.troll.regular;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
 * 会员操作注解
 * @author xiaofanku
 * @since 20200529
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MemberAction {
    /**
     * 行为
     * @return
     */
    ForumActionEnum action();

    /**
     * 主要的参数名, 默认为id
     * 如果是登录或注册使用:用户名(names)
     * 方法的返回值用以识别会员
     *
     * @return
     */
    String keyName() default "id";

    /**
     * 主要参数的类型, 默认为Long.class
     *
     * @return
     */
    Class<?> keyType() default Long.class;

    /**
     * 注解的方法是否返回boolean值,
     * true的返回值是Optional/Boolean
     * false的返回值是实体对象/主键
     * @return
     */
    boolean isBool() default true;
}
